Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: decouple docs release and introduce versioning #1752

Merged
merged 2 commits into from
Nov 19, 2024

Conversation

butler54
Copy link
Collaborator

@butler54 butler54 commented Nov 18, 2024

Types of changes

  • Hot fix (emergency fix and release)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Documentation (change which affects the documentation site)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Release (develop -> main)

Quality assurance (all should be covered).

  • My code follows the code style of this project.
  • Documentation for my change is up to date?
  • My PR meets testing requirements.
  • All new and existing tests passed.
  • All commits are signed-off.

Summary

This PR does two things:

  1. Decouples documentation build from the build of the actual codebase
  2. Introduces versioning at the major.minor level for the documentation website.

Once this PR works and runs through a release cycle the intent would be to further decouple the release to minimise issues associated with build changes (e.g. credential expiry; flaky access etc).

Closes: #1547

Key links:

Before you merge

  • Ensure it is a 'squash commit' if not a release.
  • Ensure CI is currently passing
  • Check sonar. If you are working for a fork a maintainer will reach out, if required.

Signed-off-by: Chris Butler <[email protected]>
Signed-off-by: Chris Butler <[email protected]>
Copy link
Collaborator

@vikas-agarwal76 vikas-agarwal76 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Member

@jpower432 jpower432 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@butler54 butler54 merged commit 0bd1b70 into develop Nov 19, 2024
15 checks passed
@butler54 butler54 deleted the decouple-release branch November 19, 2024 03:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support multiple version of trestle docs using mike or similar on mkdocs website.
3 participants